Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh contributing guidelines to match current situation #1359

Merged
merged 2 commits into from
Sep 13, 2022

Conversation

osma
Copy link
Member

@osma osma commented Sep 13, 2022

Reasons for creating this PR

The CONTRIBUTING.md document is quite old, from 2016. The development situation has changed since then so it needed a refresh.

Link to relevant issue(s), if any

Description of the changes in this PR

Update sections of CONTRIBUTING.md to match current situation and link to most recent resources.

Note that I have also added a link to CONTRIBUTING.md to the home page of the wiki (last section about development processes), as suggested in #1286.

Known problems or uncertainties in this PR

n/a

Checklist

  • phpUnit tests pass locally with my changes
  • I have added tests that show that the new code works, or tests are not relevant for this PR (e.g. only HTML/CSS changes)
  • The PR doesn't reduce accessibility of the front-end code (e.g. tab focus, scaling to different resolutions, use of .sr-only class, color contrast)
  • The PR doesn't introduce unintended code changes (e.g. empty lines or useless reindentation)

@osma osma added this to the 2.16 milestone Sep 13, 2022
@osma osma self-assigned this Sep 13, 2022
@codecov
Copy link

codecov bot commented Sep 13, 2022

Codecov Report

Merging #1359 (f91f139) into master (0640b5e) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #1359   +/-   ##
=========================================
  Coverage     71.15%   71.15%           
  Complexity     1649     1649           
=========================================
  Files            32       32           
  Lines          3786     3786           
=========================================
  Hits           2694     2694           
  Misses         1092     1092           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@kinow kinow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 huge improvement. A few random comments, but nothing that really needs to be incorporated into this change.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@osma
Copy link
Member Author

osma commented Sep 13, 2022

Thanks a lot for the suggestions @kinow , I will try to incorporate some/all of them into this PR!

@sonarcloud
Copy link

sonarcloud bot commented Sep 13, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@osma
Copy link
Member Author

osma commented Sep 13, 2022

I made all the changes suggested by @kinow , thanks again! I think it's now good enough so I'm merging this.

@osma osma merged commit 17162a2 into master Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need for contributing guidelines document
2 participants